SetStringValue(DicomElement,string[]) Method

Summary

Sets the string value(s) of a Data Element.

Syntax

C++

Java

public bool SetStringValue( 
   DicomElement element, 
   string[] value 
)

Public Overloads Function SetStringValue( _ 
   ByVal element As DicomElement, _ 
   ByVal value() As String _ 
) As Boolean

public boolean setStringValues(DicomElement element, String[] value)

public: 
bool SetStringValue(  
   DicomElement^ element, 
   array<String^>^ value 
)

Parameters

element
An item in the Data Set.

value
Character string that contains the string value(s) to set. If you want to set multiple values in the Value Field, put all string values in this array.

Return Value

true if the string value(s) were set successfully. false if could not set the string value(s) of the Data Element.

Remarks

This overload of SetStringValue differs from other versions (SetStringValue) in that it is missing the last argument (DicomCharacterSetType). This overload is affected by the value(s) in the Specific Character Set (0008,0005) Attribute.

The following DICOM Value Representations are affected by Attribute Specific Character Set (0008,0005)

SH (Short String)
LO (Long String)
ST (Short Text)
LT (Long Text)
UT (Unlimited Text)
PN (Person Name)

If element is one of these Value Representations and the string cannot be represented using the standard character set (ASCII characters), then this overload attempts to encode the string using one or character sets stored in the Specific Character Set Attribute (0008,0005). Before calling this method with unicode strings, make sure that the Specific Character Set Attribute of the DicomDataSet contains values for any character set that is necessary. For example, when encoding a japanese string the following are some of the possible values for specific character:

"ISO_IR 192" (Unicode in UTF-8)
"ISO_IR 13" (Japanese, single-byte, no code extensions)
"\ISO 2022 IR 87" (Default, JIS X 0208)
"ISO 2022 IR 13\ISO 2022 IR 87" (JIS X 0201, JIS X 0208)

For more information, see Part 3 section 'C.12.1.1.2 Specific Character Set' of the DICOM Specification. If more than one value is stored in the Value Field of the Data Element, you must set all values at the same time. This method can be called only if the Value Representation of the Data Element is: